Hanami backend/fi.aalto.cs.hanami.courses

Package-level declarations

Types

AllCoursesResponse

@Serializable

data class AllCoursesResponse(val aplusUrl: String, val courses: List<AllCoursesResponse.Entry>)

ApiErrorEnvelopeV1

@Serializable

data class ApiErrorEnvelopeV1(val error: ApiErrorV1)

ApiErrorV1

@Serializable

data class ApiErrorV1(val code: String, val message: String, val requestId: String, val issues: List<ApiIssueV1> = emptyList())

ApiIssueV1

@Serializable

data class ApiIssueV1(val path: String, val code: String, val message: String)

AssignmentPoints

data class AssignmentPoints(val points: Int, val maxPoints: Int, val bestSubmissionId: Long?, val submissions: List<SubmissionPoints>)

AssignmentProgress

@Serializable

data class AssignmentProgress(val id: Long, val name: String, val fileFields: List<ExerciseFileField>, val points: Int, val maxPoints: Int, val bestSubmissionId: Long?, val submissions: List<SubmissionProgress>)

AuthorizedCourseRequest

data class AuthorizedCourseRequest(val entry: CourseEntry, val token: String, val identity: Identity, val role: Role)

ConfiguredGraderView

@Serializable

data class ConfiguredGraderView(val userId: Long, val username: String, val fullName: String?, val role: Role, val languages: List<String>, val feedbackTags: List<String>, val gradingTags: List<String>)

CourseAssignment

@Serializable

data class CourseAssignment(val id: Long, val name: String, val fileFields: List<ExerciseFileField>)

CourseConfiguration

@Serializable

data class CourseConfiguration(val schemaVersion: Int = CURRENT_SCHEMA_VERSION, val id: Long, val slug: String, val name: String, val languages: List<String>, val highlightLanguages: List<String>, val courseConfigUrl: String? = null, val templates: CourseTemplateSettings, val ltiLoginUrl: String? = null, val listed: Boolean = true, val tags: List<CourseTag> = emptyList(), val visibleTagSlugs: List<String> = emptyList(), val graders: List<CourseGrader> = emptyList(), val manualGradingExercises: List<Long> = emptyList())

CourseConfigurationCreateBody

@Serializable

data class CourseConfigurationCreateBody(val courseId: Long, val copyFromCourseId: Long? = null, val slug: String? = null, val name: String? = null, val languages: List<String>? = null, val highlightLanguages: List<String>, val listed: Boolean? = null, val courseConfigUrl: String? = null, val visibleTagSlugs: List<String>? = null, val graders: List<CourseGrader>? = null, val manualGradingExercises: List<Long>? = null)

CourseConfigurationDiscovery

@Serializable

data class CourseConfigurationDiscovery(val id: Long, val name: String, val code: String? = null, val htmlUrl: String? = null, val configured: Boolean)

CourseConfigurationValidationException

class CourseConfigurationValidationException(val path: String, message: String, cause: Throwable? = null) : InputValidationException

CourseDraftContext

@Serializable

data class CourseDraftContext(val tags: List<CourseTag>, val ltiLoginUrl: String?, val templateStatus: TemplateCatalogStatus? = null)

CourseEntry

data class CourseEntry(val configuration: CourseConfiguration, val revision: Long)

CourseExerciseSource

data class CourseExerciseSource(val id: Long, val name: String, val moduleName: String, val maxPoints: Int)

CourseFileResolution

@Serializable

data class CourseFileResolution(val exerciseId: Long, val submissionId: Long, val assignmentName: String, val assignmentHtmlUrl: String, val points: Int, val maxPoints: Int, val url: String?)

CourseFileUrl

@Serializable

data class CourseFileUrl(val filename: String, val resolution: CourseFileResolution?)

CourseGrader

@Serializable

data class CourseGrader(val userId: Long, val languages: List<String>, val feedbackTags: List<String> = emptyList(), val gradingTags: List<String> = emptyList())

CourseModule

@Serializable

data class CourseModule(val name: String, val assignments: List<CourseAssignment>)

CoursePoints

data class CoursePoints(val pointsPerAssignment: Map<Long, AssignmentPoints>, val pointsPerWeek: Map<Long, WeekPoints>)

CourseRefreshJob

@Serializable

data class CourseRefreshJob(val id: String, val courseId: Long, val kind: String, val phase: String, val updatedAtMillis: Long)

CourseService

class CourseService : AutoCloseable

Serves authorization-scoped course data and owns the process-local course caches.

CourseSettingsDocumentV1

@Serializable

data class CourseSettingsDocumentV1(val revision: Long, val schemaVersion: Int, val courseId: Long, val slug: String, val name: String, val languages: List<String>, val highlightLanguages: List<String>, val courseConfigUrl: String? = null, val templates: CourseTemplateSettings, val listed: Boolean, val visibleTagSlugs: List<String>, val graders: List<CourseGrader>, val manualGradingExercises: List<Long>, val tags: List<CourseTag>, val ltiLoginUrl: String? = null)

CourseSettingsService

class CourseSettingsService

Owns course discovery, validation, replacement, and cache invalidation.

CourseSettingsUpdateV1

@Serializable

data class CourseSettingsUpdateV1(val schemaVersion: Int, val slug: String, val name: String, val languages: List<String>, val highlightLanguages: List<String>, val courseConfigUrl: String? = null, val templates: CourseTemplateSettings, val listed: Boolean, val visibleTagSlugs: List<String>, val graders: List<CourseGrader>, val manualGradingExercises: List<Long>)

CourseSnapshot

@Serializable

data class CourseSnapshot(val courseId: Long, val lang: String, val courseConfigName: String, val weeks: List<CourseWeek>, val fetchedAtMillis: Long, val freshness: DataFreshness, val refreshing: Boolean, val cacheDisposition: String = "miss")

CourseSource

interface CourseSource

Supplies course structure and progress data from A+ in Hanami-owned models.

CoursesResponse

@Serializable

data class CoursesResponse(val aplusUrl: String, val courses: List<CoursesResponse.Entry>)

CourseStructure

data class CourseStructure(val snapshot: CourseSnapshot, val sourceWeeks: List<CourseWeekSource>, val fileFieldsByExercise: Map<Long, List<ExerciseFileField>>)

CourseTag

@Serializable

data class CourseTag(val slug: String, val name: String, val description: String, val color: String, val fontWhite: Boolean)

CourseTemplates

interface CourseTemplates

CourseTemplateSettings

@Serializable

data class CourseTemplateSettings(val automaticExtensions: Boolean, val extensions: List<String>, val excludedPathSegments: List<String>)

CourseWeek

@Serializable

data class CourseWeek(val id: Long, val name: String, val modules: List<CourseModule>)

CourseWeekSource

data class CourseWeekSource(val name: String, val id: Long, val exercises: List<CourseExerciseSource>)

DataFreshness

@Serializable

enum DataFreshness : Enum<DataFreshness>

DifficultyPoints

@Serializable

data class DifficultyPoints(val difficulty: String, val points: Int, val maxPoints: Int)

DuplicateCourseException

class DuplicateCourseException : IllegalStateException

EmailBody

@Serializable

data class EmailBody(val email: String)

ExerciseFileField

@Serializable

data class ExerciseFileField(val key: String, val filename: String)

ExternalCourse

data class ExternalCourse(val id: Long?, val name: String?, val code: String?, val instanceName: String?, val htmlUrl: String, val endingTime: String, val imageUrl: String?)

ExternalCourseTag

data class ExternalCourseTag(val slug: String, val name: String, val description: String, val color: String, val fontWhite: Boolean)

GraderIdsBody

@Serializable

data class GraderIdsBody(val userIds: List<Long>)

HighlightLanguageCatalog

object HighlightLanguageCatalog

ManualGradingExerciseConflictException

class ManualGradingExerciseConflictException(claimantCourseId: Long) : IllegalStateException

ModuleFileLatest

@Serializable

data class ModuleFileLatest(val filename: String, val latestBestSubmissionExerciseId: Long?, val latestBestSubmissionId: Long?)

ModuleWeekUrls

@Serializable

data class ModuleWeekUrls(val name: String, val files: List<CourseFileUrl>)

ProgressModule

@Serializable

data class ProgressModule(val name: String, val assignments: List<AssignmentProgress>, val files: List<ModuleFileLatest>)

ProgressWeek

@Serializable

data class ProgressWeek(val id: Long, val name: String, val points: Int, val maxPoints: Int, val modules: List<ProgressModule>)

RevisionBody

@Serializable

data class RevisionBody(val revision: Long)

RevisionConflictException

class RevisionConflictException : IllegalStateException

StudentBestSnapshot

@Serializable

data class StudentBestSnapshot(val courseId: Long, val lang: String, val studentId: String, val weeks: List<ProgressWeek>, val fetchedAtMillis: Long, val freshness: DataFreshness, val refreshing: Boolean, val cacheDisposition: String = "miss")

StudentPointsSummary

@Serializable

data class StudentPointsSummary(val points: Int, val maxPoints: Int, val difficulties: List<DifficultyPoints>)

StudentsResponse

@Serializable

data class StudentsResponse(val students: List<StudentView>, val total: Int, val fetchedAtMillis: Long, val freshness: DataFreshness, val refreshing: Boolean, val cacheDisposition: String = "miss")

StudentView

@Serializable

data class StudentView(val id: Long, val username: String?, val fullName: String?, val email: String?, val studentId: String?, val tagSlugs: List<String> = emptyList(), val participantPageUrl: String? = null)

SubmissionPoints

data class SubmissionPoints(val id: Long, val submittedAt: String, val grade: Int)

SubmissionProgress

@Serializable

data class SubmissionProgress(val id: Long, val submittedAt: String, val grade: Int)

TemplateCatalogState

@Serializable

enum TemplateCatalogState : Enum<TemplateCatalogState>

TemplateCatalogStatus

@Serializable

data class TemplateCatalogStatus(val source: String?, val state: TemplateCatalogState, val discoveredModules: Int, val cachedModules: Int, val failedModules: Int, val lastSuccessfulCheckAt: Long?, val errorCode: String?, val effectiveExtensions: List<String>)

TemplateExtractionPolicy

data class TemplateExtractionPolicy(val extensions: Set<String>, val excludedPathSegments: Set<String>)

UnknownCourseException

class UnknownCourseException(val courseId: Long) : RuntimeException

UnknownCourseExerciseException

class UnknownCourseExerciseException(val courseId: Long, val exerciseId: Long) : RuntimeException

UnknownCourseWeekException

class UnknownCourseWeekException(val courseId: Long, val weekId: Long) : RuntimeException

VersionedCourseConfiguration

@Serializable

data class VersionedCourseConfiguration(val revision: Long, val schemaVersion: Int, val id: Long, val slug: String, val name: String, val languages: List<String>, val highlightLanguages: List<String>, val courseConfigUrl: String?, val templates: CourseTemplateSettings, val ltiLoginUrl: String?, val listed: Boolean = true, val tags: List<CourseTag> = emptyList(), val visibleTagSlugs: List<String> = emptyList(), val graders: List<CourseGrader> = emptyList(), val manualGradingExercises: List<Long> = emptyList())

WeekFileUrls

@Serializable

data class WeekFileUrls(val week: String, val modules: List<ModuleWeekUrls>)

WeekPoints

data class WeekPoints(val points: Int, val maxPoints: Int)

Functions

publicCourseSettingsApiRoutes

fun Route.publicCourseSettingsApiRoutes(sessions: SessionService, settings: CourseSettingsService)

refreshedFromAplus

fun CourseEntry.refreshedFromAplus(aplusTags: List<ExternalCourseTag>, ltiLoginUrl: String?): CourseConfiguration

toCourseTags

fun List<ExternalCourseTag>.toCourseTags(): List<CourseTag>